au PAY（ネット支払い）アプリ方式決済API一覧（随時決済）

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranAupayApp 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額利用金額+税送料で1円～300,000円設定可能税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
Tax	tax	半角数字7桁税送料利用金額+税送料で1円～300,000円設定可能税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
PaymentType	paymentType	半角数字1桁決済タイプ 1：随時決済 ※随時決済を行う場合、必須です。

URL

/payment/EntryTranAupayApp.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}

URL

/payment/EntryTranAupayApp.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID":"a6a6b0061347e90cdef806b39bd28705",
    "accessPass":"5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAupayApp 決済実行

決済処理を行い結果を返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
AuAcceptCode	auAcceptCode	必須半角英数20桁 au承諾番号

URL

/payment/ExecTranAupayApp.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "auAcceptCode": "12345678901234567890"
}

URL

/payment/ExecTranAupayApp.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&AuAcceptCode=12345678901234567890

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID 【取引登録】で指定した値をを返却します。
Status	status	現状態対象取引の取引状態を返却します。・REQSUCCESS：要求成功
TranDate	tranDate	半角数字14桁処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
AupayAppVoucherNo	aupayAppVoucherNo	半角数字19桁 au伝票番号決済完了時にKDDIから発行される一意の番号です。キャンセル時には発行されません。
CheckString	checkString	半角英数記号32桁改ざんチェック文字列加盟店様がau PAY サイトにアクセスする際に必要となるGW事業者コードを返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "REQSUCCESS",
    "tranDate": "20231212162711",
    "aupayAppVoucherNo": "123456789012345678",
    "checkString"": "6e72a8518107a9fca81d3afee6972e45",
    "gwJgyshaCd": "12345",
    "seqNo": "59c86c3d2cc366d862ebc162b4038d5d92bb8bef01777b7db08c213a5ba194f4"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=REQSUCCESS&TranDate=20231212162711&AupayAppVoucherNo=123456789012345678&CheckString=6e72a8518107a9fca81d3afee6972e45&GwJgyshaCd=12345&SeqNo=59c86c3d2cc366d862ebc162b4038d5d92bb8bef01777b7db08c213a5ba194f4

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayAppCancelReturn キャンセル・返品

対象の取引をキャンセルします。実売上または即時売上状態の取引は一部返金が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額仮売上、実売上、即時売上時の合計利用金額と一致する金額を設定するとキャンセルします。（一部キャンセルを行いたい場合）キャンセルしたい金額を設定します。設定した金額がお客様に返金され、差額は実売上、即時売上の状態のままとなります。例）　実売上時の利用金額 = 1000円　設定した利用金額＝ 200円上記の条件でキャンセルを行った結果　売上金額 = 800円　キャンセル金額 = 200円
CancelTax	cancelTax	半角数字7桁キャンセル税送料

URL

/payment/AupayAppCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "200"
}

URL

/payment/AupayAppCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=200

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態対象取引の取引状態を返却します。キャンセル・返品成功時は以下のステータスが返却されます。・CANCEL：キャンセル・RETURN：返品
Amount	amount	必須半角数字7桁利用金額利用金額からキャンセル金額を減算した結果を返却します。
Tax	tax	必須半角数字7桁税送料税送料からキャンセル税送料を減算した結果を返却します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額対象取引でキャンセルした利用金額の累計を返却します。
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料対象取引でキャンセルした税送料の累計を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "CANCEL",
    "amount": "0",
    "tax": "0",
    "cancelAmount": "1000",
    "cancelTax": "10"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=10

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayAppSales 実売上

仮売上の決済に対して実売上を行います。実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額対象決済の利用金額を指定してください。取引の利用金額と一致しない場合エラーとなります。
Tax	tax	半角数字7桁税送料対象決済の税送料を指定してください。取引の税送料と一致しない場合エラーとなります。

URL

/payment/AupayAppSales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "tax": "100"
}

URL

/payment/AupayAppSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000&Tax=100

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status	status	必須現状態対象取引の取引状態を返却します。・SALES：実売上
Amount	amount	必須半角数字7桁利用金額実売上した利用金額を返却します。
Tax	tax	必須半角数字7桁税送料実売上したを税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "orderID": "ORDER0000001",
    "status": "SALES",
    "amount": "1000",
    "tax": "100"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=100

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayAppChange 金額変更

仮売上取引に対して金額変更を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
Amount	amount	必須半角数字7桁変更後利用金額利用金額+税送料で1円～300,000円設定可能税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
Tax	tax	半角数字7桁変更後税送料利用金額+税送料で1円～300,000円設定可能税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

URL

/payment/AupayAppChange.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/AupayAppChange.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を返却します。
Status	status	必須現状態対象取引の取引状態を返却します。・AUTH：仮売上
Amount	amount	必須半角数字7桁変更後利用金額変更後金額を返却します。
Tax	tax	必須半角数字7桁変更後税送料変更後金額を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "amount": "1000",
  "tax": "100"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=AUTH&Amount=1000&Tax=100

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001" 
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001